PolyGrid
Type
widget
Summary
Widget to represent data in table format.
Description
PolyGrid is the perfect widget for developers who want to display data in a simple and modern way. With PolyGrid you can quickly create beautiful widget-driven native scrollable tables for all platforms supported by LiveCode, ensuring optimal performance. Scrollbar support for all platforms means your data is always easily accessible, regardless of device or screen size.
Children Properties
Message
| Name | Summary | Syntax |
|---|---|---|
| headerClick | This message is sent when the table header is clicked. | headerClick <pColumnNumber> |
| columnEndResize | This message is sent when a column is finished resizing. | columnEndResize <pColumnNumber> |
| selectionChanged | Sent when the user selects one or more rows. | selectionChanged <pHilitedRow>,<pPrevHilitedRows> |
| cellDoubleClick | sent when the mouse button is released at the end of a double-click on the same cell. | cellDoubleClick <pColumnNumber>,<pRowNumber>,<pCellRect> |
| cellClick | Sent when the mouse button is released at the end of a cell click. | cellClick <pColumnNumber>,<pRowNumber>,<pCellRect> |
| columnBeginResize | This message is sent when a column resize is initiated. | columnBeginResize <pColumnNumber> |
| scrollBeginDrag | Sent when one of the widget's scrollBars initiates a scroll. | scrollBeginDrag <pAxis> |
| scrollEndDrag | Sent when one of the widget's scrollBars finishes scrolling. | scrollEndDrag <pAxis> |
| contentChange | Sent when the content of the PolyGrid is modified. | contentChange |
| rowFirstDraw | This message is sent when a list item is showed the first time. | rowFirstDraw <pItemIndex> |
| scrollerDidScroll | This message is sent when the widget's content is scrolled. | scrollerDidScroll |
| mouseRelease | Sent when the user releases the mouse outside the control that was clicked. | mouseRelease |
| mouseEnter | mouseEnter. | mouseEnter |
| mouseLeave | mouseLeave. | mouseLeave |
Property
| Name | Summary | Syntax |
|---|---|---|
| textSize | The textSize of a PolyGrid defines the height of the text of its content. | set the textSize of widget to <Integer> get the textSize of widget |
| pgVScrollBarIsShowing | Determine if the vertical scrollbar is currently visible. | get the pgVScrollBarIsShowing of widget |
| addDataBefore | A method for adding data to the table. | set the addDataBefore of widget to <List> |
| Text | The text property reflects the content in tab delimited form. | set the text of widget to <Data> get the text of widget |
| pgHilitedData | Get or set the hilited data array corresponding to hilited rows. | set the pgHilitedData of widget to <DataArray> get the pgHilitedData of widget |
| pgPageSize | Number of rows displayed in the visible area of the PolyGrid. | get the pgPageSize of widget |
| hScroll | Specifies the horizontal hScroll of a PolyGrid. | set the hScroll of widget to {<Integer>} get the hScroll of widget |
| hScrollBar | Show or hide built-in horizontal scrollbar. | set the hScrollBar of widget to <String> get the hScrollBar of widget |
| pgTextColor | Specifies the color of the table text. | set the pgTextColor of widget to <RGB Color> get the pgTextColor of widget |
| hGrid | Defines if the horizontal lines are shown. | set the hGrid of widget to <Boolean> get the hGrid of widget |
| rowColor | Specifies the fill color of rows. | set the rowColor of widget to <RGB Color> get the rowColor of widget |
| csvData | The csvData property reflects the content in CSV format. | set the csvData of widget to <CSV> get the csvData of widget |
| multiHilite | Specifies if the PolyGrid widget will allow to select more than one row at the same time | set the multiHilite of widget to {true | false} get the multiHilite of widget |
| pgDeleteColumnByNumber | Delete a column by index. | set the pgDeleteColumnByNumber of widget to <Integer> |
| pgMouseCell | Returns the current cell coordinate under the mouse cursor | get the pgMouseCell of widget |
| pgBackgroundColor | Specifies the background color of the table. | set the pgBackgroundColor of widget to <RGBA Color> get the pgBackgroundColor of widget |
| pgDeleteColumnByName | Delete a column by name. | set the pgDeleteColumnByName of widget to <String> |
| addData | A method for adding data to the table. | set the addData of widget to <List> |
| rowHeight | Set the height of rows. | set the rowHeight of widget to <Integer> get the rowHeight of widget |
| scrollbarSecondColor | Specifies the secondary color that the table's scroll bar indicators will have. | set the scrollbarSecondColor of widget to <RGBA Color> get the scrollbarSecondColor of widget |
| firstRowInView | Returns the first visible row | get the firstRowInView of widget |
| fixedFirstCol | Makes the first column to be always visible | set the fixedFirstCol of widget to <boolean> get the fixedFirstCol of widget |
| headerDividers | Set to true to show header dividers. | set the headerDividers of widget to {true | false} get the headerDividers of widget |
| pgHiliteColor | The color of the highlighted rows. | set the pgHiliteColor of widget to <RGBA Color> get the pgHiliteColor of widget |
| pgTextOfRow | Get and set the text of a row in a PolyGrid. | set the pgTextOfRow of widget to <String> get the pgTextOfRow of widget |
| headerHeight | Set the height of columns header. | set the headerHeight of widget to <Integer> get the headerHeight of widget |
| pgData | Get or set the data array that the PolyGrid will display. | set the pgData of widget to <DataArray> get the pgData of widget |
| scrollbarBackgroundColor | Specifies the background color of the table's scroll bars. | set the scrollbarBackgroundColor of widget to <RGBA Color> get the scrollbarBackgroundColor of widget |
| pgColumnNames | Specifies the names of columns. | set the pgColumnNames of widget to <CommaDelimitedList> get the pgColumnNames of widget |
| dataHeight | Reports the height needed by an object to display its full contents without scrolling. | get the dataHeight of widget |
| pgTextOfCell | Get and set the text of a cell in a PolyGrid. | set the pgTextOfCell of widget to {<column number>, <row number>} get the pgTextOfCell of widget |
| pgBorderColor | Specifies the color of an PolyGrid's border. | set the pgBorderColor of widget to <RGBA Color> get the pgBorderColor of widget |
| headerTextStyle | Specifies the style or styles applied to the table header text. | set the headerTextStyle of widget to {plain|bold|italic|bold,italic} get the headerTextStyle of widget |
| rawData | Rad-only property to get the internal array representation of PolyGrid's content. | get the rawData of widget |
| headerBackgroundColor2 | Sets the bottom color of the table header | set the headerBackgroundColor2 of widget to <RGBA Color> get the headerBackgroundColor2 of widget |
| pgHilitedTextColor | The text color of the highlighted rows. | set the pgHilitedTextColor of widget to <RGB Color> get the pgHilitedTextColor of widget |
| pgColumnWidths | Specifies the width for each column. | set the pgColumnWidths of widget to <CommaDelimitedListOfNumbers> get the pgColumnWidths of widget |
| scrollbarWidth | Get or set the width of the scroll bars | set the scrollbarWidth of widget to <Integer> get the scrollbarWidth of widget |
| pgDataOfRow | Get and set array of data from one row. | set the pgDataOfRow of widget to {<NewDataOfRowArray>} get the pgDataOfRow of widget |
| lastRowInView | Returns the last visible row | get the lastRowInView of widget |
| pgHScrollBarIsShowing | Determine if the horizontal scrollbar is currently visible. | get the pgHScrollBarIsShowing of widget |
| margin | Specifies the margin that all cells in a PolyGrid will have. | set the margin of widget to <Integer> get the margin of widget |
| hilitedRow | Specifies the line(s) that will be hilited on a PolyGrid control. | set the hilitedRow of widget to <Number/List> get the hilitedRow of widget |
| roundedRadius | The radius of the corners of the widget. | set the roundedRadius of widget to <integer> get the roundedRadius of widget |
| headerTextColor | Specifies the color of the table header text. | set the headerTextColor of widget to <RGB Color> get the headerTextColor of widget |
| pgColumnLabels | Specifies the text to show on top of columns. | set the pgColumnLabels of widget to <CommaDelimitedList> get the pgColumnLabels of widget |
| pgInternalPointer | It is a pointer to tell certain properties where they should operate. | set the pgInternalPointer of widget to <String> get the pgInternalPointer of widget |
| showHeader | Specifies if the PolyGrid widget will show the column header | set the showHeader of widget to {true | false} get the showHeader of widget |
| headerTextSize | The headerTextSize of a PolyGrid defines the height of the text of its header. | set the headerTextSize of widget to <Integer> get the headerTextSize of widget |
| scroll | Specifies the vertical scroll of a PolyGrid. | set the scroll of widget to {<Integer>} get the scroll of widget |
| pgHilitedText | Get or set the text corresponding to the highlighted rows. | set the pgHilitedText of widget to <Text> get the pgHilitedText of widget |
| scrollbarFirstColor | Specifies the main color that the table scroll bar indicators will have. | set the scrollbarFirstColor of widget to <RGBA Color> get the scrollbarFirstColor of widget |
| vGrid | Defines if the vertical lines are shown. | set the vGrid of widget to <Boolean> get the vGrid of widget |
| pgMouseCellText | Returns the text under the mouse cursor | get the pgMouseCellText of widget |
| lineSize | Specifies the thickness with which the inner lines and borders of the PolyGrid are drawn. | set the lineSize of widget to <Integer> get the lineSize of widget |
| fillEmptyRows | Set to true to fill with empty rows. | set the fillEmptyRows of widget to {true | false} get the fillEmptyRows of widget |
| touchScrolling | Specifies if the PolyGrid widget will respond to mouse scrolling gestures | set the touchScrolling of widget to {true | false} get the touchScrolling of widget |
| numberOfColumns | Reports the total number of columns in a PolyGrid. | get the numberOfColumns of widget |
| addDataAfter | A method for adding data to the table. | set the addDataAfter of widget to <List> |
| scrollHilitedElementIntoView | Specifies if the PolyGrid widget should adjust scroll to bring hilited element into view | set the scrollHilitedElementIntoView of widget to {true | false} get the scrollHilitedElementIntoView of widget |
| pgColumns | Get or set the data array that the PolyGrid uses to build columns. | set the pgColumns of widget to <Array> get the pgColumns of widget |
| pgDeleteRow | Delete rows. | set the pgDeleteRow of widget to <List> |
| widgetIsScrolling | Find out if the widget is currently scrolling. | get the widgetIsScrolling of widget |
| rowAlternateColor | Specifies the fill color of alternate rows when property alternateRowColors is true. | set the rowAlternateColor of widget to <RGB Color> get the rowAlternateColor of widget |
| scrollbarBorderColor | Specifies the border color of the table's scroll bars. | set the scrollbarBorderColor of widget to <RGBA Color> get the scrollbarBorderColor of widget |
| rectOfCell | Get the rect of a cell in a PolyGrid. | get the rectOfCell of widget |
| headerBackgroundColor | Sets the upper color of the table header | set the headerBackgroundColor of widget to <RGBA Color> get the headerBackgroundColor of widget |
| mouseHoverHilite | Selects the mouse row when the mouse is moved | set the mouseHoverHilite of widget to {true | false} get the mouseHoverHilite of widget |
| pgContentTypeOfColumn | Get the data type of a column in a PolyGrid. | get the pgContentTypeofColumn of widget |
| vScrollBar | Show or hide built-in vertical scrollbar. | set the vScrollBar of widget to <String> get the vScrollBar of widget |
| lineColor | Sets the color of the table column dividers. | set the lineColor of widget to <RGBA Color> get the lineColor of widget |
| headerLineColor | Sets the color of the table column header dividers. | set the headerLineColor of widget to <RGBA Color> get the headerLineColor of widget |
| alternateRowColors | Set to true to alternate the background colors of every other row. | set the alternateRowColors of widget to {true | false} get the alternateRowColors of widget |
| pgAutoHilite | Specifies if the PolyGrid widget will respond to mouse events | set the pgAutoHilite of widget to {true | false} get the pgAutoHilite of widget |
| dataWidth | Reports the width needed by an object to display its full contents without scrolling. | get the dataWidth of widget |
| tsvData | The tsvData property reflects the content in TSV format. | set the tsvData of widget to <TSV> get the tsvData of widget |
| numberOfRows | Reports the total number of rows in a PolyGrid. | get the numberOfRows of widget |
| pgMoveColumn | Change a column position. | set the pgMoveColumn of widget to <List> |